<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class IModifier</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface IModifier</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Represents exactly one interval in exactly one navigator. Can be used with  <a href="../sde_fastsearch_result/INavigator.html">INavigator</a> to represent a drill-down path and create a corresponding  query.</p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: IModifier.html 20 2010-01-28 14:33:07Z kenn.north $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---result---IModifier.php.html">/src/sde/fastsearch/result/IModifier.php</a> (line <span class="field">35</span>)
		</p>
		
				
		<pre><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a>
   |
   --IModifier</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																						
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#attach" title="details" class="method-name">attach</a>
											(<span class="var-type"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>&nbsp;<span class="var-name">$navigator</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/IModifier.html">IModifier</a></span>
										<a href="#detach" title="details" class="method-name">detach</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getAttribute" title="details" class="method-name">getAttribute</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getCount" title="details" class="method-name">getCount</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">flaot</span>
										<a href="#getDocumentRatio" title="details" class="method-name">getDocumentRatio</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">stirng</span>
										<a href="#getName" title="details" class="method-name">getName</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>
										<a href="#getNavigator" title="details" class="method-name">getNavigator</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getValue" title="details" class="method-name">getValue</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isDetached" title="details" class="method-name">isDetached</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isInterval" title="details" class="method-name">isInterval</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setName" title="details" class="method-name">setName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodattach" id="attach"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">attach</span> (line <span class="line-number">84</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the enclosing navigator.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			attach
		</span>
					(<span class="var-type"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>&nbsp;<span class="var-name">$navigator</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>
				<span class="var-name">$navigator</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddetach" id="detach"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">detach</span> (line <span class="line-number">91</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a new modifier identical to this modifier, but removed from  its INavigator.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/IModifier.html">IModifier</a></span>
		<span class="method-name">
			detach
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetAttribute" id="getAttribute"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getAttribute</span> (line <span class="line-number">72</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the name of the attribute affected by the modifier.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getAttribute
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetCount" id="getCount"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getCount</span> (line <span class="line-number">53</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the number of documents in this interval.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getCount
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetDocumentRatio" id="getDocumentRatio"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getDocumentRatio</span> (line <span class="line-number">66</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the ratio of this modifier's document count to the total document  count.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">flaot</span>
		<span class="method-name">
			getDocumentRatio
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getName</span> (line <span class="line-number">41</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the print name of this modifier.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">stirng</span>
		<span class="method-name">
			getName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetNavigator" id="getNavigator"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getNavigator</span> (line <span class="line-number">78</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the enclosing navigator.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/INavigator.html">INavigator</a></span>
		<span class="method-name">
			getNavigator
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetValue" id="getValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getValue</span> (line <span class="line-number">59</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the internal value of this modifier.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getValue
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisDetached" id="isDetached"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isDetached</span> (line <span class="line-number">98</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether this modifer is detached.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isDetached
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisInterval" id="isInterval"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isInterval</span> (line <span class="line-number">105</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns whether this modifier represents a range interval in the form  [from;to] or not.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isInterval
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetName" id="setName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setName</span> (line <span class="line-number">47</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Updates the print name of this modifier.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../sde_fastsearch_result/IResultObject.html">IResultObject</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../sde_fastsearch_result/IResultObject.html#methodprepareUnset">IResultObject::prepareUnset()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:36:04 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>